<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2010 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: ComPortCommand.html 42 2011-03-22 17:26:28Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.jvser;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.Arrays;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    import static org.dellroad.jvser.RFC2217.COM_PORT_OPTION;<a name="line.12"></a>
<FONT color="green">013</FONT>    import static org.dellroad.jvser.RFC2217.SERVER_OFFSET;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    /**<a name="line.15"></a>
<FONT color="green">016</FONT>     * Superclass for RFC 2217 commands.<a name="line.16"></a>
<FONT color="green">017</FONT>     *<a name="line.17"></a>
<FONT color="green">018</FONT>     * &lt;p&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * Instances of this class (and all subclasses) are immutable.<a name="line.19"></a>
<FONT color="green">020</FONT>     * &lt;/p&gt;<a name="line.20"></a>
<FONT color="green">021</FONT>     *<a name="line.21"></a>
<FONT color="green">022</FONT>     * @see &lt;a href="http://tools.ietf.org/html/rfc2217"&gt;RFC 2217&lt;/a&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     */<a name="line.23"></a>
<FONT color="green">024</FONT>    public abstract class ComPortCommand {<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>        final String name;<a name="line.26"></a>
<FONT color="green">027</FONT>        final int[] bytes;<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>        /**<a name="line.29"></a>
<FONT color="green">030</FONT>         * Constructor.<a name="line.30"></a>
<FONT color="green">031</FONT>         *<a name="line.31"></a>
<FONT color="green">032</FONT>         * @param name human readable name of this command<a name="line.32"></a>
<FONT color="green">033</FONT>         * @param command required {@code COM-PORT-OPTION} command byte value (must be the client-to-server value)<a name="line.33"></a>
<FONT color="green">034</FONT>         * @param bytes encoded command starting with the {@code COM-PORT-OPTION} byte<a name="line.34"></a>
<FONT color="green">035</FONT>         * @throws NullPointerException if {@code bytes} is null<a name="line.35"></a>
<FONT color="green">036</FONT>         * @throws IllegalArgumentException if {@code bytes} has length that is too short or too long<a name="line.36"></a>
<FONT color="green">037</FONT>         * @throws IllegalArgumentException if {@code bytes[0]} is not {@link RFC2217#COM_PORT_OPTION}<a name="line.37"></a>
<FONT color="green">038</FONT>         * @throws IllegalArgumentException if {@code command} is greater than or equal to {@link RFC2217#SERVER_OFFSET}<a name="line.38"></a>
<FONT color="green">039</FONT>         * @throws IllegalArgumentException if {@code bytes[1]} is not {@code command}<a name="line.39"></a>
<FONT color="green">040</FONT>         *  or {@code command} + {@link RFC2217#SERVER_OFFSET}<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        protected ComPortCommand(String name, int command, int[] bytes) {<a name="line.42"></a>
<FONT color="green">043</FONT>            this.name = name;<a name="line.43"></a>
<FONT color="green">044</FONT>            int minLength = 2 + this.getMinPayloadLength();<a name="line.44"></a>
<FONT color="green">045</FONT>            int maxLength = 2 + this.getMaxPayloadLength();<a name="line.45"></a>
<FONT color="green">046</FONT>            if (bytes.length &lt; minLength || bytes.length &gt; maxLength)<a name="line.46"></a>
<FONT color="green">047</FONT>                throw new IllegalArgumentException("length = " + bytes.length + " is not in the range " + minLength + ".." + maxLength);<a name="line.47"></a>
<FONT color="green">048</FONT>            this.bytes = bytes.clone();                 // maintain immutability<a name="line.48"></a>
<FONT color="green">049</FONT>            if (this.bytes[0] != COM_PORT_OPTION)<a name="line.49"></a>
<FONT color="green">050</FONT>                throw new IllegalArgumentException("not a COM-PORT-OPTION");<a name="line.50"></a>
<FONT color="green">051</FONT>            if (command &gt;= SERVER_OFFSET)<a name="line.51"></a>
<FONT color="green">052</FONT>                throw new IllegalArgumentException("invalid command " + command);<a name="line.52"></a>
<FONT color="green">053</FONT>            if (this.getCommand() != command &amp;&amp; this.getCommand() != command + SERVER_OFFSET)<a name="line.53"></a>
<FONT color="green">054</FONT>                throw new IllegalArgumentException("not a " + name + " option");<a name="line.54"></a>
<FONT color="green">055</FONT>        }<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /**<a name="line.57"></a>
<FONT color="green">058</FONT>         * Determine if this command is client-to-server or server-to-client.<a name="line.58"></a>
<FONT color="green">059</FONT>         *<a name="line.59"></a>
<FONT color="green">060</FONT>         * @return true if this command is sent from the server to the client, false for the opposite<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        public final boolean isServerCommand() {<a name="line.62"></a>
<FONT color="green">063</FONT>            return this.getCommand() &gt;= SERVER_OFFSET;<a name="line.63"></a>
<FONT color="green">064</FONT>        }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>        /**<a name="line.66"></a>
<FONT color="green">067</FONT>         * Get the encoding of this instance.<a name="line.67"></a>
<FONT color="green">068</FONT>         *<a name="line.68"></a>
<FONT color="green">069</FONT>         * @return encoding starting with {@code COM-PORT-OPTION}<a name="line.69"></a>
<FONT color="green">070</FONT>         */<a name="line.70"></a>
<FONT color="green">071</FONT>        public final int[] getBytes() {<a name="line.71"></a>
<FONT color="green">072</FONT>            return this.bytes.clone();                  // maintain immutability<a name="line.72"></a>
<FONT color="green">073</FONT>        }<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>        /**<a name="line.75"></a>
<FONT color="green">076</FONT>         * Get the command byte.<a name="line.76"></a>
<FONT color="green">077</FONT>         *<a name="line.77"></a>
<FONT color="green">078</FONT>         * @return RFC 2217-defined byte value for this command<a name="line.78"></a>
<FONT color="green">079</FONT>         */<a name="line.79"></a>
<FONT color="green">080</FONT>        public final int getCommand() {<a name="line.80"></a>
<FONT color="green">081</FONT>            return this.bytes[1] &amp; 0xff;<a name="line.81"></a>
<FONT color="green">082</FONT>        }<a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>        /**<a name="line.84"></a>
<FONT color="green">085</FONT>         * Get the human-readable name of this option.<a name="line.85"></a>
<FONT color="green">086</FONT>         */<a name="line.86"></a>
<FONT color="green">087</FONT>        public String getName() {<a name="line.87"></a>
<FONT color="green">088</FONT>            return this.name + (this.isServerCommand() ? "[S]" : "[C]");<a name="line.88"></a>
<FONT color="green">089</FONT>        }<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /**<a name="line.91"></a>
<FONT color="green">092</FONT>         * Get the human-readable description of this option.<a name="line.92"></a>
<FONT color="green">093</FONT>         */<a name="line.93"></a>
<FONT color="green">094</FONT>        @Override<a name="line.94"></a>
<FONT color="green">095</FONT>        public abstract String toString();<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        /**<a name="line.97"></a>
<FONT color="green">098</FONT>         * Apply visitor pattern.<a name="line.98"></a>
<FONT color="green">099</FONT>         *<a name="line.99"></a>
<FONT color="green">100</FONT>         * @param sw visitor switch handler<a name="line.100"></a>
<FONT color="green">101</FONT>         */<a name="line.101"></a>
<FONT color="green">102</FONT>        public abstract void visit(ComPortCommandSwitch sw);<a name="line.102"></a>
<FONT color="green">103</FONT>    <a name="line.103"></a>
<FONT color="green">104</FONT>        /**<a name="line.104"></a>
<FONT color="green">105</FONT>         * Get the option payload as bytes.<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        byte[] getPayload() {<a name="line.107"></a>
<FONT color="green">108</FONT>            byte[] buf = new byte[this.bytes.length - 2];<a name="line.108"></a>
<FONT color="green">109</FONT>            for (int i = 2; i &lt; bytes.length; i++)<a name="line.109"></a>
<FONT color="green">110</FONT>                buf[i - 2] = (byte)this.bytes[i];<a name="line.110"></a>
<FONT color="green">111</FONT>            return buf;<a name="line.111"></a>
<FONT color="green">112</FONT>        }<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>        /**<a name="line.114"></a>
<FONT color="green">115</FONT>         * Get minimum required length of the payload of this command.<a name="line.115"></a>
<FONT color="green">116</FONT>         */<a name="line.116"></a>
<FONT color="green">117</FONT>        abstract int getMinPayloadLength();<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        /**<a name="line.119"></a>
<FONT color="green">120</FONT>         * Get maximum required length of the payload of this command.<a name="line.120"></a>
<FONT color="green">121</FONT>         */<a name="line.121"></a>
<FONT color="green">122</FONT>        abstract int getMaxPayloadLength();<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        @Override<a name="line.124"></a>
<FONT color="green">125</FONT>        public boolean equals(Object obj) {<a name="line.125"></a>
<FONT color="green">126</FONT>            if (obj == null || obj.getClass() != getClass())<a name="line.126"></a>
<FONT color="green">127</FONT>                return false;<a name="line.127"></a>
<FONT color="green">128</FONT>            ComPortCommand that = (ComPortCommand)obj;<a name="line.128"></a>
<FONT color="green">129</FONT>            return Arrays.equals(this.bytes, that.bytes);<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>        @Override<a name="line.132"></a>
<FONT color="green">133</FONT>        public int hashCode() {<a name="line.133"></a>
<FONT color="green">134</FONT>            int hash = 0;<a name="line.134"></a>
<FONT color="green">135</FONT>            for (int i = 0; i &lt; this.bytes.length; i++)<a name="line.135"></a>
<FONT color="green">136</FONT>                hash = hash * 37 + this.bytes[i];<a name="line.136"></a>
<FONT color="green">137</FONT>            return hash;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>




























































</PRE>
</BODY>
</HTML>
